home *** CD-ROM | disk | FTP | other *** search
/ OpenGL Superbible (2nd Edition) / OpenGL SuperBible e2.iso / tools / Mesa-3.0 / INCLUDE / GL / OSMESA.H < prev    next >
Encoding:
C/C++ Source or Header  |  1998-07-26  |  7.0 KB  |  244 lines
  1. /* $Id: osmesa.h,v 1.2 1998/07/26 01:33:51 brianp Exp $ */
  2.  
  3. /*
  4.  * Mesa 3-D graphics library
  5.  * Version:  3.0
  6.  * Copyright (C) 1995-1998  Brian Paul
  7.  *
  8.  * This library is free software; you can redistribute it and/or
  9.  * modify it under the terms of the GNU Library General Public
  10.  * License as published by the Free Software Foundation; either
  11.  * version 2 of the License, or (at your option) any later version.
  12.  *
  13.  * This library is distributed in the hope that it will be useful,
  14.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16.  * Library General Public License for more details.
  17.  *
  18.  * You should have received a copy of the GNU Library General Public
  19.  * License along with this library; if not, write to the Free
  20.  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21.  */
  22.  
  23.  
  24. /*
  25.  * $Log: osmesa.h,v $
  26.  * Revision 1.2  1998/07/26 01:33:51  brianp
  27.  * added WINGDIAPI and APIENTRY keywords per Ted Jump
  28.  *
  29.  * Revision 1.1  1998/02/13 03:17:50  brianp
  30.  * Initial revision
  31.  *
  32.  */
  33.  
  34.  
  35. /*
  36.  * Mesa Off-Screen rendering interface.
  37.  *
  38.  * This is an operating system and window system independent interface to
  39.  * Mesa which allows one to render images into a client-supplied buffer in
  40.  * main memory.  Such images may manipulated or saved in whatever way the
  41.  * client wants.
  42.  *
  43.  * These are the API functions:
  44.  *   OSMesaCreateContext - create a new Off-Screen Mesa rendering context
  45.  *   OSMesaMakeCurrent - bind an OSMesaContext to a client's image buffer
  46.  *                       and make the specified context the current one.
  47.  *   OSMesaDestroyContext - destroy an OSMesaContext
  48.  *   OSMesaGetCurrentContext - return thread's current context ID
  49.  *   OSMesaPixelStore - controls how pixels are stored in image buffer
  50.  *   OSMesaGetIntegerv - return OSMesa state parameters
  51.  *
  52.  *
  53.  * The limits on the width and height of an image buffer are MAX_WIDTH and
  54.  * MAX_HEIGHT as defined in Mesa/src/config.h.  Defaults are 1280 and 1024.
  55.  * You can increase them as needed but beware that many temporary arrays in
  56.  * Mesa are dimensioned by MAX_WIDTH or MAX_HEIGHT.
  57.  */
  58.  
  59.  
  60.  
  61. #ifndef OSMESA_H
  62. #define OSMESA_H
  63.  
  64.  
  65.  
  66. #ifdef __cplusplus
  67. extern "C" {
  68. #endif
  69.  
  70.  
  71. #include "GL/gl.h"
  72.  
  73.  
  74.  
  75. #define OSMESA_MAJOR_VERSION 3
  76. #define OSMESA_MINOR_VERSION 0
  77.  
  78.  
  79.  
  80. /*
  81.  * Values for the format parameter of OSMesaCreateContext()
  82.  * New in version 2.0.
  83.  */
  84. #define OSMESA_COLOR_INDEX    GL_COLOR_INDEX
  85. #define OSMESA_RGBA        GL_RGBA
  86. #define OSMESA_BGRA        0x1
  87. #define OSMESA_ARGB        0x2
  88. #define OSMESA_RGB        GL_RGB
  89. #define OSMESA_BGR        0x4
  90.  
  91.  
  92. /*
  93.  * OSMesaPixelStore() parameters:
  94.  * New in version 2.0.
  95.  */
  96. #define OSMESA_ROW_LENGTH    0x10
  97. #define OSMESA_Y_UP        0x11
  98.  
  99.  
  100. /*
  101.  * Accepted by OSMesaGetIntegerv:
  102.  */
  103. #define OSMESA_WIDTH        0x20
  104. #define OSMESA_HEIGHT        0x21
  105. #define OSMESA_FORMAT        0x22
  106. #define OSMESA_TYPE        0x23
  107.  
  108.  
  109.  
  110. typedef struct osmesa_context *OSMesaContext;
  111.  
  112.  
  113. #if defined(__BEOS__) || defined(__QUICKDRAW__)
  114. #pragma export on
  115. #endif
  116.  
  117.  
  118. /*
  119.  * Create an Off-Screen Mesa rendering context.  The only attribute needed is
  120.  * an RGBA vs Color-Index mode flag.
  121.  *
  122.  * Input:  format - one of OSMESA_COLOR_INDEX, OSMESA_RGBA, OSMESA_BGRA,
  123.  *                  OSMESA_ARGB, OSMESA_RGB, or OSMESA_BGR.
  124.  *         sharelist - specifies another OSMesaContext with which to share
  125.  *                     display lists.  NULL indicates no sharing.
  126.  * Return:  an OSMesaContext or 0 if error
  127.  */
  128. WINGDIAPI OSMesaContext APIENTRY OSMesaCreateContext( GLenum format,
  129.                                           OSMesaContext sharelist );
  130.  
  131.  
  132.  
  133.  
  134. /*
  135.  * Destroy an Off-Screen Mesa rendering context.
  136.  *
  137.  * Input:  ctx - the context to destroy
  138.  */
  139. WINGDIAPI void APIENTRY OSMesaDestroyContext( OSMesaContext ctx );
  140.  
  141.  
  142.  
  143. /*
  144.  * Bind an OSMesaContext to an image buffer.  The image buffer is just a
  145.  * block of memory which the client provides.  Its size must be at least
  146.  * as large as width*height*sizeof(type).  Its address should be a multiple
  147.  * of 4 if using RGBA mode.
  148.  *
  149.  * Image data is stored in the order of glDrawPixels:  row-major order
  150.  * with the lower-left image pixel stored in the first array position
  151.  * (ie. bottom-to-top).
  152.  *
  153.  * Since the only type initially supported is GL_UNSIGNED_BYTE, if the
  154.  * context is in RGBA mode, each pixel will be stored as a 4-byte RGBA
  155.  * value.  If the context is in color indexed mode, each pixel will be
  156.  * stored as a 1-byte value.
  157.  *
  158.  * If the context's viewport hasn't been initialized yet, it will now be
  159.  * initialized to (0,0,width,height).
  160.  *
  161.  * Input:  ctx - the rendering context
  162.  *         buffer - the image buffer memory
  163.  *         type - data type for pixel components, only GL_UNSIGNED_BYTE
  164.  *                supported now
  165.  *         width, height - size of image buffer in pixels, at least 1
  166.  * Return:  GL_TRUE if success, GL_FALSE if error because of invalid ctx,
  167.  *          invalid buffer address, type!=GL_UNSIGNED_BYTE, width<1, height<1,
  168.  *          width>internal limit or height>internal limit.
  169.  */
  170. WINGDIAPI GLboolean APIENTRY OSMesaMakeCurrent( OSMesaContext ctx,
  171.                                     void *buffer, GLenum type,
  172.                                     GLsizei width, GLsizei height );
  173.  
  174.  
  175.  
  176.  
  177. /*
  178.  * Return the current Off-Screen Mesa rendering context handle.
  179.  */
  180. WINGDIAPI OSMesaContext APIENTRY OSMesaGetCurrentContext( void );
  181.  
  182.  
  183.  
  184. /*
  185.  * Set pixel store/packing parameters for the current context.
  186.  * This is similar to glPixelStore.
  187.  * Input:  pname - OSMESA_ROW_LENGTH
  188.  *                    specify actual pixels per row in image buffer
  189.  *                    0 = same as image width (default)
  190.  *                 OSMESA_Y_UP
  191.  *                    zero = Y coordinates increase downward
  192.  *                    non-zero = Y coordinates increase upward (default)
  193.  *         value - the value for the parameter pname
  194.  *
  195.  * New in version 2.0.
  196.  */
  197. WINGDIAPI void APIENTRY OSMesaPixelStore( GLint pname, GLint value );
  198.  
  199.  
  200.  
  201. /*
  202.  * Return context info.  This is like glGetIntegerv.
  203.  * Input:  pname -
  204.  *                 OSMESA_WIDTH  return current image width
  205.  *                 OSMESA_HEIGHT  return current image height
  206.  *                 OSMESA_FORMAT  return image format
  207.  *                 OSMESA_TYPE  return color component data type
  208.  *                 OSMESA_ROW_LENGTH return row length in pixels
  209.  *                 OSMESA_Y_UP returns 1 or 0 to indicate Y axis direction
  210.  *         value - pointer to integer in which to return result.
  211.  */
  212. WINGDIAPI void APIENTRY OSMesaGetIntegerv( GLint pname, GLint *value );
  213.  
  214.  
  215.  
  216. /*
  217.  * Return the depth buffer associated with an OSMesa context.
  218.  * Input:  c - the OSMesa context
  219.  * Output:  width, height - size of buffer in pixels
  220.  *          bytesPerValue - bytes per depth value (2 or 4)
  221.  *          buffer - pointer to depth buffer values
  222.  * Return:  GL_TRUE or GL_FALSE to indicate success or failure.
  223.  *
  224.  * New in Mesa 2.4.
  225.  */
  226. WINGDIAPI GLboolean APIENTRY OSMesaGetDepthBuffer( OSMesaContext c,
  227.                                        GLint *width, GLint *height,
  228.                                        GLint *bytesPerValue, void **buffer );
  229.  
  230.  
  231.  
  232.  
  233. #if defined(__BEOS__) || defined(__QUICKDRAW__)
  234. #pragma export off
  235. #endif
  236.  
  237.  
  238. #ifdef __cplusplus
  239. }
  240. #endif
  241.  
  242.  
  243. #endif
  244.